Package de.bitmarckservice.kernpruefung

Class Pruefer

    • Constructor Summary

      Constructors 
      Constructor Description
      Pruefer()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addRueckgabeMeldung​(java.lang.String fehlernummer)
      Aufruf der gleichnamigen Methode des Rückgabe-Objektes.
      protected void addRueckgabeMeldung​(java.lang.String fehlernummer, int returnCode)
      Aufruf der gleichnamigen Methode des Rückgabe-Objektes.
      protected abstract Fehlerkatalog getFehlerkatalog()
      In einem konkreten Prüfer liefert diese Methode den für diesen Prüfer zuständigen Fehlerkatalog.
      abstract java.lang.String getKennung()
      Liefert die Kennung des konkreten Prüfers.
      abstract int getLaenge()
      Die konkrete Instanz dieser Methode liefert die Datenlänge des zugrundeliegenden Datensatzes / Bausteins.
      java.lang.String getMeldung​(java.lang.String fehlernummer)
      Liefert zu der Fehlernummer fehlernummer die Fehlermeldung aus dem Fehlerkatalog.
      DefaultRueckgabe getRueckgabe()
      Liefert das mit setRueckgabe() gesetzte Rückgabe-Objekt.
      java.lang.String getSatz()
      Liefert den mit setSatz() gesetzten Satz.
      java.util.Calendar getVerarbeitungsdatum()
      Liefert das mit setVerarbeitungsdatum() gesetzte Datum.
      java.lang.String getVerarbeitungsdatumString()
      Liefert das Datum, das mittels setVerarbeitungsdatum() gesetzt wurde als String im Format yyyymmdd.
      Vorlaufsatz getVorlaufsatz()
      Liefert das mit setVorlaufsatz() gesetzte Vorlaufsatz-Objekt.
      abstract void pruefe()
      In der konkreten Instanz dieser Methode erfolgt die Prüfung.
      void setRueckgabe​(DefaultRueckgabe rueckgabe)
      Das Rückgabe-Objekt rueckgabe wird in der konkreten Instanz dieser Klasse verwendet um Fehler-Codes und -Nachrichten zu speichern.
      void setSatz​(java.lang.String satz)
      Das Argument satz ist in der konkreten Instanz dieser Klasse der zu untersuchende Daten-Satz (Satz oder Baustein).
      void setVerarbeitungsdatum​(java.util.Calendar verarbeitungsdatum)
      Setzt das Verarbeitungsdatum auf verarbeitungsdatum.
      void setVorlaufsatz​(Vorlaufsatz vorlaufsatz)
      Setzt das Objekt, das den Vorlaufsatz repräsentiert.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Pruefer

        public Pruefer()

    • Method Detail

      • addRueckgabeMeldung

        protected void addRueckgabeMeldung​(java.lang.String fehlernummer)
        Aufruf der gleichnamigen Methode des Rückgabe-Objektes.

        Convenience Method.

        Parameters:
        fehlernummer - Dreistellige Fehlernummer (z.B. 010 von DSER010)
        See Also:
        DefaultRueckgabe.addRueckgabeMeldung(String), getRueckgabe()

      • getFehlerkatalog

        protected abstract Fehlerkatalog getFehlerkatalog()
        In einem konkreten Prüfer liefert diese Methode den für diesen Prüfer zuständigen Fehlerkatalog.
        Returns:
        Fehlerkatalog

      • getKennung

        public abstract java.lang.String getKennung()
        Liefert die Kennung des konkreten Prüfers.
        Returns:
        Kennung des Prüfers, z.B. DSER.

      • getLaenge

        public abstract int getLaenge()
        Die konkrete Instanz dieser Methode liefert die Datenlänge des zugrundeliegenden Datensatzes / Bausteins.

        Isat die Länge variabel, so liefert diese Methode 0.

        Bei Sätzen ist das die Länge deas Satzes ohne die Bausteine.

        Returns:
        0 oder die Datenlänge des Satzes / Bausteins

      • getMeldung

        public final java.lang.String getMeldung​(java.lang.String fehlernummer)
        Liefert zu der Fehlernummer fehlernummer die Fehlermeldung aus dem Fehlerkatalog. Die Fehlernummer ist der Teil des Fehlercodes nach der Kennung.
        Parameters:
        fehlernummer - Fehlernummer
        Returns:
        Fehlermeldung

      • getRueckgabe

        public final DefaultRueckgabe getRueckgabe()
        Liefert das mit setRueckgabe() gesetzte Rückgabe-Objekt.
        Returns:
        rueckgabe Rückgabe

      • getSatz

        public final java.lang.String getSatz()
        Liefert den mit setSatz() gesetzten Satz.
        Returns:
        satz Datensatz

      • getVerarbeitungsdatum

        public java.util.Calendar getVerarbeitungsdatum()
        Liefert das mit setVerarbeitungsdatum() gesetzte Datum.
        Returns:
        Verarbeitungsdatum

      • getVerarbeitungsdatumString

        public java.lang.String getVerarbeitungsdatumString()
        Liefert das Datum, das mittels setVerarbeitungsdatum() gesetzt wurde als String im Format yyyymmdd.
        Returns:
        Verarbeitungsdatum als String

      • getVorlaufsatz

        public Vorlaufsatz getVorlaufsatz()
        Liefert das mit setVorlaufsatz() gesetzte Vorlaufsatz-Objekt.
        Returns:
        vorlaufsatz Vorlaufsatz

      • pruefe

        public abstract void pruefe()
                     throws DatenlaengeNichtErwartetException
        In der konkreten Instanz dieser Methode erfolgt die Prüfung.

        Vorgehen: Zunächst werden durch passende Setter Werte im Prüfer-Objekt zur Verfügung gestellt. Anschließend wird diese Methode aufgerufen.

        Throws:
        DatenlaengeNichtErwartetException - Datenlänge nicht erwartet

      • setRueckgabe

        public final void setRueckgabe​(DefaultRueckgabe rueckgabe)
        Das Rückgabe-Objekt rueckgabe wird in der konkreten Instanz dieser Klasse verwendet um Fehler-Codes und -Nachrichten zu speichern.
        Parameters:
        rueckgabe - Rückgabe

      • setSatz

        public void setSatz​(java.lang.String satz)
        Das Argument satz ist in der konkreten Instanz dieser Klasse der zu untersuchende Daten-Satz (Satz oder Baustein).

        Ist satz nicht plausibel, so wird in dem durch setRueckgabe() übergebenen Rückgabeobjekt eine entsprechende Nachricht gespeichert.

        Parameters:
        satz - Datensatz

      • setVerarbeitungsdatum

        public void setVerarbeitungsdatum​(java.util.Calendar verarbeitungsdatum)
        Setzt das Verarbeitungsdatum auf verarbeitungsdatum. Dieses Datum wird während der gesamten Prüfung als aktuelles Verarbeitungsdatum verwendet.
        Parameters:
        verarbeitungsdatum - Verarbeitungsdatum

      • setVorlaufsatz

        public void setVorlaufsatz​(Vorlaufsatz vorlaufsatz)
        Setzt das Objekt, das den Vorlaufsatz repräsentiert.
        Parameters:
        vorlaufsatz - Vorlaufsatz